Doc: definitions expressed as a table in constructive_ereal.v#1452
Conversation
|
I'm lost, didn't we said that bullet lists would be easier to use? |
Yes, but also that we should try to use tables when reasonable. |
|
Did we converge on some "definition" of reasonable? |
I think that "unreasonable" was implicitly defined as "when formatting is too painful because there are many RHS that require several lines each" |
|
Mmmhhh, I am concerned by the fact that the source file is much less readable. |
|
The last commit has restored the detailed documentation and kept the table as well, which acts a a digest of the detailed documentation: this provides an overview of the documentation while keeping the source code file readable. |
|
arg, the last commit was rejected, looks I do not have the rights to push @yoshihiro503 |
|
@yoshihiro503 I PRed to your PR instead |
separate digest from detailed documentation
constructive_ereal.v
Motivation for this change
Source code looks:
Html doc looks:

Checklist
CHANGELOG_UNRELEASED.mdReference: How to document
Reminder to reviewers